refactor(connector): Add a dummy trait WithOptions
#14175
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Current dependencies on/for this PR:
This stack of pull requests is managed by Graphite. |
xxchan
force-pushed
the
12-25-refactor_connector_Add_a_dummy_trait_WithOptions_
branch
from
cbda545 to
a4945e4
Compare
xxchan
changed the base branch from
main
to
12-25-refactor_source_remove_unnecessary_Box_for_NexmarkProperties
9 tasks
xxchan
force-pushed
the
12-25-refactor_connector_Add_a_dummy_trait_WithOptions_
branch
from
5106232 to
1a654b3
Compare
xxchan
commented
Dec 25, 2023
Comment on lines
+17
to
+33
| /// Marker trait for `WITH` options. Only for `#[derive(WithOptions)]`, should not be used manually. | ||
| /// | ||
| /// This is used to ensure the `WITH` options types have reasonable structure. | ||
| /// | ||
| /// TODO: add this bound for sink. There's a `SourceProperties` trait for sources, but no similar | ||
| /// things for sinks. | ||
| pub trait WithOptions { | ||
| #[doc(hidden)] | ||
| #[inline(always)] | ||
| fn assert_receiver_is_with_options(&self) {} | ||
| } | ||
|
|
||
| // Currently CDC properties are handled specially. | ||
| // - It simply passes HashMap to Java DBZ. | ||
| // - It's not handled by serde. | ||
| // - It contains fields other than WITH options. | ||
| // TODO: remove the workaround here. And also use #[derive] for it. |
xxchan
commented
Dec 25, 2023
Comment on lines
+51
to
+57
| /// | ||
| /// Note: here we assumes the struct is parsed by `serde`. If it's not the case, | ||
| /// the generated `yaml` might be inconsistent with the actual parsing logic. | ||
| /// TODO: improve the test to check whether serde is used. | ||
| /// | ||
| /// - For sources, the parsing logic is in `TryFromHashMap`. | ||
| /// - For sinks, the parsing logic is in `TryFrom<SinkParam>`. |
xxchan
commented
Dec 25, 2023
xxchan
force-pushed
the
12-25-refactor_connector_Add_a_dummy_trait_WithOptions_
branch
3 times, most recently
from
c3cc640 to
94bc3a2
Compare
xxchan
changed the base branch from
12-25-refactor_source_remove_unnecessary_Box_for_NexmarkProperties
to
12-25-refactor_source_unify_s3_v2_handling_in_ConnectorProperties_extract
This was referenced Dec 25, 2023
xxchan
force-pushed
the
12-25-refactor_source_unify_s3_v2_handling_in_ConnectorProperties_extract
branch
from
d6e8b64 to
1ff6db4
Compare
xxchan
force-pushed
the
12-25-refactor_connector_Add_a_dummy_trait_WithOptions_
branch
2 times, most recently
from
307f0da to
5bb84dd
Compare
xxchan
force-pushed
the
12-25-refactor_source_unify_s3_v2_handling_in_ConnectorProperties_extract
branch
from
71d2b0f to
ecba13b
Compare
xxchan
force-pushed
the
12-25-refactor_connector_Add_a_dummy_trait_WithOptions_
branch
from
9af8ff0 to
da8f4e4
Compare
xxchan
force-pushed
the
12-25-refactor_source_unify_s3_v2_handling_in_ConnectorProperties_extract
branch
from
ecba13b to
e44b49f
Compare
xxchan
force-pushed
the
12-25-refactor_connector_Add_a_dummy_trait_WithOptions_
branch
from
da8f4e4 to
6173db2
Compare
Base automatically changed from
12-25-refactor_source_unify_s3_v2_handling_in_ConnectorProperties_extract
to
main
December 27, 2023 15:04
xxchan
force-pushed
the
12-25-refactor_connector_Add_a_dummy_trait_WithOptions_
branch
from
6173db2 to
e2f5a96
Compare
xxchan
deleted the
12-25-refactor_connector_Add_a_dummy_trait_WithOptions_
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.
What's changed and what's your intention?
To enforce children types are also marked with
WithOptions.As proposed by Bugen here #13654 (comment)
Checklist
./risedev check(or alias,./risedev c)Documentation
Release note
If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.